home *** CD-ROM | disk | FTP | other *** search
/ ShareWare OnLine 2 / ShareWare OnLine Volume 2 (CMS Software)(1993).iso / database / ind200.zip / INTERMEN.HLP < prev    next >
Text File  |  1991-01-31  |  10KB  |  172 lines
  1. ***************************************************************************
  2. ******************** HELP FOR "TERMS TO INDEX" MENU ***********************
  3. ***************************************************************************
  4.  
  5. QUICK START: See the end of the HELP screen in the "Generate Index" Menu.
  6.  
  7. OVERVIEW: The "Terms to Index" menu includes options which enable you
  8.           to tell INDEX! which words or phrases you want it to search for
  9.           and how these words and phrases are to appear in the final index.
  10.           To take a simple example, you might wish to search for the
  11.           phrase "George Washington" and have it appear in your index as
  12.           "Washington, George". The specific options follow:
  13.  
  14. LOAD CODES: With this menu option, you tell INDEX! which database file
  15.             of indexable terms to use in generating the index for a
  16.             particular project. The database file will have the
  17.             extension .IND.
  18.  
  19. CREATE/EDIT: This option allows you to build a database of indexable terms
  20.              from scratch (CREATE); alternatively, you can add to or edit
  21.              an existing database of indexable terms (EDIT). In either
  22.              case, you assign your database a file name, and it is this
  23.              file name which you use in the LOAD CODES option before
  24.              asking INDEX! to index your chapter files. The filename must
  25.              have the extension .IND, which INDEX! supplies if you do
  26.              not include an extension when you name the file.
  27.  
  28.              Note that in addition to the main database (extension .IND),
  29.              INDEX! creates subsidiary files which enable rapid searching
  30.              of the database. The three subsidiary files have the database
  31.              filename plus the extensions .IXN, .IXM, and .IXP. If you
  32.              delete a database from the DOS prompt, you should also delete
  33.              these files.
  34.  
  35.              COMMANDS for using the index database appear at the bottom of
  36.              of the screen, as follows:
  37.  
  38.                F2 ADD: Add a record to the database. Use F2 after filling
  39.                        in the fields of a new blank record.
  40.   
  41.                F3 CHANGE: Change a record in the database. Use F3 after
  42.                           editing the fields of a record already in the
  43.                           database.
  44.  
  45.                F4 DELETE: Delete a record from the database. Use F4 to
  46.                           remove a record that you no longer want in your
  47.                           index.
  48.  
  49.                F5: NEW: Bring up a new record with blank fields. Use F5
  50.                         when you are looking at an old record and you wish
  51.                         to bring up a blank screen to enter a new record.
  52.                         When the new record is completed, add it with F2.
  53.  
  54.                F6: SEARCH: Search for a record in the database. Use F6 to
  55.                            search by record number, search-phrase, or
  56.                            main entry.
  57.  
  58.                PgUp: Go to previous record.
  59.  
  60.                PgDn: Go to next record.
  61.  
  62.                ESC: Quit.
  63.  
  64.             FIELDS for each database record are used as follows:
  65.  
  66.                SRCH: Enter the word or phrase you want INDEX! to search
  67.                      for to add an item to your index. Up to 30 characters.
  68.                      Searches are case sensitive.
  69.  
  70.                MAIN: For the indexable item entered in SRCH, enter here
  71.                      the main entry as you want it to appear in the final
  72.                      index.
  73.  
  74.                      If you wish to use Ventura's SortKey feature, you
  75.                      enter sort keys at the ends of these fields, within
  76.                      square brackets. Thus if you want "20th Century Fox"
  77.                      to be alphabetized with the T's rather than before the
  78.                      A's, enter "20th Century Fox[Twentieth Century Fox]".
  79.                      The SortKey feature can be used with either the MAIN
  80.                      or SUBR fields.
  81.  
  82.                SUBR: This field name stands for SUB-entry/Reference. Enter
  83.                      either the sub-entry as you want it to appear in the
  84.                      final index (for Ventura's "I" type entries); or the
  85.                      "See" or "See also" cross reference as you want it to
  86.                      appear (for Ventura's "S" and "A" type entries). This
  87.                      field should be left blank if there is no sub-entry
  88.                      or cross reference.
  89.  
  90.                      Note that the combined lengths of MAIN and SUBR cannot
  91.                      exceed 71 characters and that the fields automatically
  92.                      adjust their lengths with reference to each other so
  93.                      you can always see how much room you have.
  94.  
  95.                TYPE: Use the TAB key to select one of three choices for
  96.                      this field: "I" for regular index entries that will
  97.                      be followed by page numbers; "S" for "See" type
  98.                      entries (as in "robins. See birds."); "A" for "See
  99.                      also" type entries, as in this example:
  100.  
  101.                                    robins 15, 27, 92
  102.                                       See also birds.
  103.  
  104.                      The most common type is "I", which is the default.
  105.  
  106. IMPORT FILE: If you make up your file of indexable terms in text form
  107.              using an ASCII text editor, you can import the text file
  108.              with this option. INDEX! creates a database from your text
  109.              file which you then use for other INDEX! operations. In
  110.              addition, INDEX! automatically creates certain ancillary
  111.              files which enable you to quickly search or edit the
  112.              resulting database. Note that ASCII files to be imported
  113.              must follow a specific form, as described in the INDEX!
  114.              manual. The ASCII file can have any name; the resulting
  115.              index database will be given the extension .IND. When an
  116.              index database is created using IMPORT, the subsidiary
  117.              files to facilitate searching the database are also created.
  118.  
  119. SAMPLE INDEX: Once you've created a database of indexable terms with
  120.               either CREATE/EDIT or IMPORT FILE, you can use this option
  121.               to produce a simulated index to see what sort of final index
  122.               your codes will generate in Ventura. This sample index
  123.               shows all your main entries, sub-entries and cross-
  124.               references exactly as they will appear in final form,
  125.               followed by "page numbers" which are actually the numbers
  126.               of the entries in the database which generated each line
  127.               in the index. When these numbers appear on a line where
  128.               real page numbers would not appear in the final index,
  129.               they are preceded by a left bracket--[. By reviewing the
  130.               sample index, you can quickly see if your codes are
  131.               entered correctly, and if any entry is incorrect, you can
  132.               tell from the numbers which entries to lookup and change in
  133.               CREATE/EDIT. A sample index has the same filename as the
  134.               index database on which it is based, plus the extension .SAI.
  135.  
  136.               Note that the creation of a sample index results in the
  137.               sorting of the index database into the proper final index
  138.               order, and a rebuilding of the subsidiary files which
  139.               enable quick searching of the database.
  140.  
  141. EXPORT FILE: The easiest way to store files of indexable terms for
  142.              future use is to export them to ASCII text file form
  143.              using this option. Such files take less space, and don't
  144.              require any of the internally-generated subsidiary files
  145.              which INDEX! uses to enable you to quickly search your
  146.              database. (When you import the ASCII text file later,
  147.              these subsidiary files are regenerated automatically.)
  148.  
  149. REPAIR INDEX: If one of INDEX!'s internally-generated subsidiary files
  150.               is accidentally lost or damaged, this function will rebuild
  151.               all subsidiary files from the main INDEX! database. If you
  152.               are unable to access a database in CREATE/EDIT or any other
  153.               menu choice, but instead receive an unusual error message
  154.               which crashes your system, one of your files is damaged.
  155.               Run this option to correct the problem. If this enables you
  156.               to use your database again, you should take the additional
  157.               precaution of rebuilding your Sample Index with the SAMPLE
  158.               INDEX option (or else  first EXPORT and then IMPORT your
  159.               database). Both of these procedures do additional error
  160.               checking, and either should correct any remaining errors
  161.               in your file.              
  162.  
  163. HELP: This option provides the on-screen information which you are now
  164.       reading.
  165.  
  166. MORE HELP: If you would like to have more help online relating to the
  167.            TERMS TO INDEX menu, you can edit the file "INTERMEN.HLP" in
  168.            any ASCII text editor, adding to or reshaping the material as
  169.            you see fit up to a maximum file size of 64K. Use spaces rather
  170.            than tabs to indent, limit line lengths to 76 characters, and
  171.            end each and every line with a carriage return.
  172.